/*
 * Copyright 2008 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package blms.repository;

import java.util.List;
import java.util.regex.PatternSyntaxException;

import blms.domain.League;
import blms.domain.User;
import blms.exception.LeagueDoesNotExistException;

/**
 * Abstract definition of a league repository. League instances may be loaded
 * and stored from different sources.
 * 
 * @see Repository
 * 
 * @author João Arthur
 * @author Jonhnny Weslley
 * @author Thiago Emmanuel
 * @version 1.00, 21/04/2008
 * @since 1.0
 */
public interface LeagueRepository extends Repository<League> {

	/**
	 * Returns <tt>true</tt> if this {@link LeagueRepository repository}
	 * contains a league with the specified name
	 * 
	 * @param name
	 *            the league name
	 * @return <tt>true</tt> if this {@link LeagueRepository repository}
	 *         contains a league with the specified name
	 */
	boolean containsLeagueName(String name);

	/**
	 * Find the {@link League} with the specified {@link User#getName() name},
	 * assuming that the league exists
	 * 
	 * @param name
	 *            The name of the league to be found
	 * @return The league with the specified name
	 * 
	 * @throws LeagueDoesNotExistException
	 *             if no leagues has the specified name
	 * @throws PatternSyntaxException
	 *             if the regular expression's syntax is invalid
	 */
	List<String> findLeagueByName(String name)
			throws LeagueDoesNotExistException;

}
